From: Chad Horohoe <chadh@wikimedia.org>
Date: Fri, 27 Feb 2015 16:35:22 +0000 (-0800)
Subject: Allow profiling of Http requests
X-Git-Tag: 1.31.0-rc.0~12193^2~1
X-Git-Url: http://git.cyclocoop.org/%7D%7Cconcat%7B?a=commitdiff_plain;h=7ee5b7d23bce8c084780499cf763e6c3b7e35541;p=lhc%2Fweb%2Fwiklou.git

Allow profiling of Http requests

Http::get/set/request() now all take a new $caller parameter
which is like $fname in databases. Pass it __METHOD__ so all
of your external requests can be grouped together in profiling.

Change-Id: Ibad219452903a9678378044595cff1231bf605d8
---

diff --git a/includes/HttpFunctions.php b/includes/HttpFunctions.php
index 3728cdf9f4..36e06b5e19 100644
--- a/includes/HttpFunctions.php
+++ b/includes/HttpFunctions.php
@@ -55,9 +55,10 @@ class Http {
 	 *		                    to avoid attacks on intranet services accessible by HTTP.
 	 *    - userAgent           A user agent, if you want to override the default
 	 *                          MediaWiki/$wgVersion
+	 * @param string $caller The method making this request, for profiling
 	 * @return string|bool (bool)false on failure or a string on success
 	 */
-	public static function request( $method, $url, $options = array() ) {
+	public static function request( $method, $url, $options = array(), $caller = __METHOD__ ) {
 		wfDebug( "HTTP: $method: $url\n" );
 
 		$options['method'] = strtoupper( $method );
@@ -69,7 +70,7 @@ class Http {
 			$options['connectTimeout'] = 'default';
 		}
 
-		$req = MWHttpRequest::factory( $url, $options );
+		$req = MWHttpRequest::factory( $url, $options, $caller );
 		$status = $req->execute();
 
 		$content = false;
@@ -87,18 +88,21 @@ class Http {
 	 *
 	 * @param string $url
 	 * @param array $options
+	 * @param string $caller The method making this request, for profiling
 	 * @return string
 	 */
-	public static function get( $url, $options = array() ) {
+	public static function get( $url, $options = array(), $caller = __METHOD__ ) {
 		$args = func_get_args();
 		if ( isset( $args[1] ) && ( is_string( $args[1] ) || is_numeric( $args[1] ) ) ) {
 			// Second was used to be the timeout
 			// And third parameter used to be $options
 			wfWarn( "Second parameter should not be a timeout." );
-			$options = isset( $args[2] ) ? $args[2] : array();
+			$options = isset( $args[2] ) && is_array( $args[2] ) ?
+				$args[2] : array();
 			$options['timeout'] = $args[1];
+			$caller = __METHOD__;
 		}
-		return Http::request( 'GET', $url, $options );
+		return Http::request( 'GET', $url, $options, $caller );
 	}
 
 	/**
@@ -107,10 +111,11 @@ class Http {
 	 *
 	 * @param string $url
 	 * @param array $options
+	 * @param string $caller The method making this request, for profiling
 	 * @return string
 	 */
-	public static function post( $url, $options = array() ) {
-		return Http::request( 'POST', $url, $options );
+	public static function post( $url, $options = array(), $caller = __METHOD__ ) {
+		return Http::request( 'POST', $url, $options, $caller );
 	}
 
 	/**
@@ -224,11 +229,23 @@ class MWHttpRequest {
 
 	public $status;
 
+	/**
+	 * @var Profiler
+	 */
+	protected $profiler;
+
+	/**
+	 * @var string
+	 */
+	protected $profileName;
+
 	/**
 	 * @param string $url Url to use. If protocol-relative, will be expanded to an http:// URL
 	 * @param array $options (optional) extra params to pass (see Http::request())
+	 * @param string $caller The method making this request, for profiling
+	 * @param Profiler $profiler An instance of the profiler for profiling, or null
 	 */
-	protected function __construct( $url, $options = array() ) {
+	protected function __construct( $url, $options = array(), $caller = __METHOD__, $profiler = null ) {
 		global $wgHTTPTimeout, $wgHTTPConnectTimeout;
 
 		$this->url = wfExpandUrl( $url, PROTO_HTTP );
@@ -271,6 +288,10 @@ class MWHttpRequest {
 		if ( $this->noProxy ) {
 			$this->proxy = ''; // noProxy takes precedence
 		}
+
+		// Profile based on what's calling us
+		$this->profiler = $profiler;
+		$this->profileName = $caller;
 	}
 
 	/**
@@ -286,11 +307,12 @@ class MWHttpRequest {
 	 * Generate a new request object
 	 * @param string $url Url to use
 	 * @param array $options (optional) extra params to pass (see Http::request())
+	 * @param string $caller The method making this request, for profiling
 	 * @throws MWException
 	 * @return CurlHttpRequest|PhpHttpRequest
 	 * @see MWHttpRequest::__construct
 	 */
-	public static function factory( $url, $options = null ) {
+	public static function factory( $url, $options = null, $caller = __METHOD__ ) {
 		if ( !Http::$httpEngine ) {
 			Http::$httpEngine = function_exists( 'curl_init' ) ? 'curl' : 'php';
 		} elseif ( Http::$httpEngine == 'curl' && !function_exists( 'curl_init' ) ) {
@@ -300,7 +322,7 @@ class MWHttpRequest {
 
 		switch ( Http::$httpEngine ) {
 			case 'curl':
-				return new CurlHttpRequest( $url, $options );
+				return new CurlHttpRequest( $url, $options, $caller, Profiler::instance() );
 			case 'php':
 				if ( !wfIniGetBool( 'allow_url_fopen' ) ) {
 					throw new MWException( __METHOD__ . ': allow_url_fopen ' .
@@ -309,7 +331,7 @@ class MWHttpRequest {
 						'http://php.net/curl.'
 					);
 				}
-				return new PhpHttpRequest( $url, $options );
+				return new PhpHttpRequest( $url, $options, $caller, Profiler::instance() );
 			default:
 				throw new MWException( __METHOD__ . ': The setting of Http::$httpEngine is not valid.' );
 		}
@@ -780,6 +802,12 @@ class CurlHttpRequest extends MWHttpRequest {
 			wfRestoreWarnings();
 		}
 
+		if ( $this->profiler ) {
+			$profileSection = $this->profiler->scopedProfileIn(
+				__METHOD__ . '-' . $this->profileName
+			);
+		}
+
 		$curlRes = curl_exec( $curlHandle );
 		if ( curl_errno( $curlHandle ) == CURLE_OPERATION_TIMEOUTED ) {
 			$this->status->fatal( 'http-timed-out', $this->url );
@@ -791,6 +819,10 @@ class CurlHttpRequest extends MWHttpRequest {
 
 		curl_close( $curlHandle );
 
+		if ( $this->profiler ) {
+			$this->profiler->scopedProfileOut( $profileSection );
+		}
+
 		$this->parseHeader();
 		$this->setStatus();
 
@@ -899,6 +931,11 @@ class PhpHttpRequest extends MWHttpRequest {
 
 		$result = array();
 
+		if ( $this->profiler ) {
+			$profileSection = $this->profiler->scopedProfileIn(
+				__METHOD__ . '-' . $this->profileName
+			);
+		}
 		do {
 			$reqCount++;
 			wfSuppressWarnings();
@@ -929,6 +966,9 @@ class PhpHttpRequest extends MWHttpRequest {
 				break;
 			}
 		} while ( true );
+		if ( $this->profiler ) {
+			$this->profiler->scopedProfileOut( $profileSection );
+		}
 
 		$this->setStatus();
 
diff --git a/tests/phpunit/includes/HttpTest.php b/tests/phpunit/includes/HttpTest.php
index fbd2c31a30..e3ee7056cb 100644
--- a/tests/phpunit/includes/HttpTest.php
+++ b/tests/phpunit/includes/HttpTest.php
@@ -486,7 +486,7 @@ class HttpTest extends MediaWikiTestCase {
 class MWHttpRequestTester extends MWHttpRequest {
 	// function derived from the MWHttpRequest factory function but
 	// returns appropriate tester class here
-	public static function factory( $url, $options = null ) {
+	public static function factory( $url, $options = null, $caller = __METHOD__ ) {
 		if ( !Http::$httpEngine ) {
 			Http::$httpEngine = function_exists( 'curl_init' ) ? 'curl' : 'php';
 		} elseif ( Http::$httpEngine == 'curl' && !function_exists( 'curl_init' ) ) {
@@ -496,7 +496,7 @@ class MWHttpRequestTester extends MWHttpRequest {
 
 		switch ( Http::$httpEngine ) {
 			case 'curl':
-				return new CurlHttpRequestTester( $url, $options );
+				return new CurlHttpRequestTester( $url, $options, $caller );
 			case 'php':
 				if ( !wfIniGetBool( 'allow_url_fopen' ) ) {
 					throw new MWException( __METHOD__ .
@@ -504,7 +504,7 @@ class MWHttpRequestTester extends MWHttpRequest {
 							. 'If possible, curl should be used instead. See http://php.net/curl.' );
 				}
 
-				return new PhpHttpRequestTester( $url, $options );
+				return new PhpHttpRequestTester( $url, $options, $caller );
 			default:
 		}
 	}